Autogenerated HTML docs for v1.5.0-rc4-16-g9e258
diff --git a/git-am.html b/git-am.html index 2a3c894..f8badfb 100644 --- a/git-am.html +++ b/git-am.html
@@ -374,6 +374,15 @@ </p> </dd> <dt> +-C<n> +</dt> +<dd> +<p> + This flag is passed to the <tt>git-apply</tt> program that applies + the patch. +</p> +</dd> +<dt> --interactive </dt> <dd> @@ -440,7 +449,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 19-Jan-2007 00:37:10 UTC +Last updated 09-Feb-2007 08:38:33 UTC </div> </div> </body>
diff --git a/git-am.txt b/git-am.txt index aa4ce1d..f7d551e 100644 --- a/git-am.txt +++ b/git-am.txt
@@ -64,6 +64,10 @@ This flag is passed to the `git-apply` program that applies the patch. +-C<n>:: + This flag is passed to the `git-apply` program that applies + the patch. + --interactive:: Run interactively, just like git-applymbox.
diff --git a/git-fast-import.html b/git-fast-import.html index 2c08b43..61b0668 100644 --- a/git-fast-import.html +++ b/git-fast-import.html
@@ -279,13 +279,13 @@ <p>This program is usually not what the end user wants to run directly. Most end users want to use one of the existing frontend programs, which parses a specific type of foreign source and feeds the contents -stored there to git-fast-import (gfi).</p> -<p>gfi reads a mixed command/data stream from standard input and +stored there to git-fast-import.</p> +<p>fast-import reads a mixed command/data stream from standard input and writes one or more packfiles directly into the current repository. When EOF is received on standard input, fast import writes out updated branch and tag refs, fully updating the current repository with the newly imported data.</p> -<p>The gfi backend itself can import into an empty repository (one that +<p>The fast-import backend itself can import into an empty repository (one that has already been initialized by <a href="git-init.html">git-init(1)</a>) or incrementally update an existing populated repository. Whether or not incremental imports are supported from a particular foreign source depends on @@ -300,7 +300,7 @@ <dd> <p> Specify the type of dates the frontend will supply to - gfi within <tt>author</tt>, <tt>committer</tt> and <tt>tagger</tt> commands. + fast-import within <tt>author</tt>, <tt>committer</tt> and <tt>tagger</tt> commands. See “Date Formats” below for details about which formats are supported, and their syntax. </p> @@ -361,7 +361,7 @@ </dt> <dd> <p> - Disable all non-fatal output, making gfi silent when it + Disable all non-fatal output, making fast-import silent when it is successful. This option disables the output shown by --stats. </p> @@ -371,9 +371,9 @@ </dt> <dd> <p> - Display some basic statistics about the objects gfi has + Display some basic statistics about the objects fast-import has created, the packfiles they were stored into, and the - memory used by gfi during this run. Showing this output + memory used by fast-import during this run. Showing this output is currently the default, but can be disabled with --quiet. </p> </dd> @@ -381,40 +381,40 @@ </div> <h2>Performance</h2> <div class="sectionbody"> -<p>The design of gfi allows it to import large projects in a minimum +<p>The design of fast-import allows it to import large projects in a minimum amount of memory usage and processing time. Assuming the frontend -is able to keep up with gfi and feed it a constant stream of data, +is able to keep up with fast-import and feed it a constant stream of data, import times for projects holding 10+ years of history and containing 100,000+ individual commits are generally completed in just 1-2 hours on quite modest (~$2,000 USD) hardware.</p> <p>Most bottlenecks appear to be in foreign source data access (the -source just cannot extract revisions fast enough) or disk IO (gfi +source just cannot extract revisions fast enough) or disk IO (fast-import writes as fast as the disk will take the data). Imports will run faster if the source data is stored on a different drive than the destination Git repository (due to less IO contention).</p> </div> <h2>Development Cost</h2> <div class="sectionbody"> -<p>A typical frontend for gfi tends to weigh in at approximately 200 +<p>A typical frontend for fast-import tends to weigh in at approximately 200 lines of Perl/Python/Ruby code. Most developers have been able to create working importers in just a couple of hours, even though it -is their first exposure to gfi, and sometimes even to Git. This is +is their first exposure to fast-import, and sometimes even to Git. This is an ideal situation, given that most conversion tools are throw-away (use once, and never look back).</p> </div> <h2>Parallel Operation</h2> <div class="sectionbody"> -<p>Like <tt>git-push</tt> or <tt>git-fetch</tt>, imports handled by gfi are safe to +<p>Like <tt>git-push</tt> or <tt>git-fetch</tt>, imports handled by fast-import are safe to run alongside parallel <tt>git repack -a -d</tt> or <tt>git gc</tt> invocations, or any other Git operation (including <tt>git prune</tt>, as loose objects -are never used by gfi).</p> -<p>gfi does not lock the branch or tag refs it is actively importing. -After the import, during its ref update phase, gfi tests each +are never used by fast-import).</p> +<p>fast-import does not lock the branch or tag refs it is actively importing. +After the import, during its ref update phase, fast-import tests each existing branch ref to verify the update will be a fast-forward update (the commit stored in the ref is contained in the new history of the commit to be written). If the update is not a -fast-forward update, gfi will skip updating that ref and instead -prints a warning message. gfi will always attempt to update all +fast-forward update, fast-import will skip updating that ref and instead +prints a warning message. fast-import will always attempt to update all branch refs, and does not stop on the first failure.</p> <p>Branch updates can be forced with --force, but its recommended that this only be used on an otherwise quiet repository. Using --force @@ -422,33 +422,33 @@ </div> <h2>Technical Discussion</h2> <div class="sectionbody"> -<p>gfi tracks a set of branches in memory. Any branch can be created +<p>fast-import tracks a set of branches in memory. Any branch can be created or modified at any point during the import process by sending a <tt>commit</tt> command on the input stream. This design allows a frontend program to process an unlimited number of branches simultaneously, generating commits in the order they are available from the source data. It also simplifies the frontend programs considerably.</p> -<p>gfi does not use or alter the current working directory, or any +<p>fast-import does not use or alter the current working directory, or any file within it. (It does however update the current Git repository, as referenced by <tt>GIT_DIR</tt>.) Therefore an import frontend may use the working directory for its own purposes, such as extracting file revisions from the foreign source. This ignorance of the working -directory also allows gfi to run very quickly, as it does not +directory also allows fast-import to run very quickly, as it does not need to perform any costly file update operations when switching between branches.</p> </div> <h2>Input Format</h2> <div class="sectionbody"> <p>With the exception of raw file data (which Git does not interpret) -the gfi input format is text (ASCII) based. This text based +the fast-import input format is text (ASCII) based. This text based format simplifies development and debugging of frontend programs, especially when a higher level language such as Perl, Python or Ruby is being used.</p> -<p>gfi is very strict about its input. Where we say SP below we mean +<p>fast-import is very strict about its input. Where we say SP below we mean <strong>exactly</strong> one space. Likewise LF means one (and only one) linefeed. Supplying additional whitespace characters will cause unexpected results, such as branch names or file names with leading or trailing -spaces in their name, or early termination of gfi when it encounters +spaces in their name, or early termination of fast-import when it encounters unexpected input.</p> <h3>Date Formats</h3> <p>The following date formats are supported. A frontend should select @@ -461,7 +461,7 @@ <dd> <p> This is the Git native format and is <tt><time> SP <offutc></tt>. - It is also gfi's default format, if --date-format was + It is also fast-import's default format, if --date-format was not specified. </p> <p>The time of the event is specified by <tt><time></tt> as the number of @@ -476,9 +476,9 @@ “+0000”, or the most common local offset. For example many organizations have a CVS repository which has only ever been accessed by users who are located in the same location and timezone. In this -case the offset from UTC can be easily assumed.</p> +case a reasonable offset from UTC could be assumed.</p> <p>Unlike the <tt>rfc2822</tt> format, this format is very strict. Any -variation in formatting will cause gfi to reject the value.</p> +variation in formatting will cause fast-import to reject the value.</p> </dd> <dt> <tt>rfc2822</tt> @@ -488,7 +488,7 @@ This is the standard email format as described by RFC 2822. </p> <p>An example value is “Tue Feb 6 11:22:18 2007 -0500”. The Git -parser is accurate, but a little on the lenient side. Its the +parser is accurate, but a little on the lenient side. It is the same parser used by <a href="git-am.html">git-am(1)</a> when applying patches received from email.</p> <p>Some malformed strings may be accepted as valid dates. In some of @@ -500,13 +500,14 @@ contained in an RFC 2822 date string is used to adjust the date value to UTC prior to storage. Therefore it is important that this information be as accurate as possible.</p> -<p>If the source material is formatted in RFC 2822 style dates, -the frontend should let gfi handle the parsing and conversion +<p>If the source material uses RFC 2822 style dates, +the frontend should let fast-import handle the parsing and conversion (rather than attempting to do it itself) as the Git parser has been well tested in the wild.</p> <p>Frontends should prefer the <tt>raw</tt> format if the source material -is already in UNIX-epoch format, or is easily convertible to -that format, as there is no ambiguity in parsing.</p> +already uses UNIX-epoch format, can be coaxed to give dates in that +format, or its format is easiliy convertible to it, as there is no +ambiguity in parsing.</p> </dd> <dt> <tt>now</tt> @@ -518,7 +519,7 @@ </p> <p>This is a toy format. The current time and timezone of this system is always copied into the identity string at the time it is being -created by gfi. There is no way to specify a different time or +created by fast-import. There is no way to specify a different time or timezone.</p> <p>This particular format is supplied as its short to implement and may be useful to a process that wants to create a new commit @@ -533,7 +534,7 @@ </dd> </dl> <h3>Commands</h3> -<p>gfi accepts several commands to update the current repository +<p>fast-import accepts several commands to update the current repository and control the current import process. More detailed discussion (with examples) of each command follows later.</p> <dl> @@ -583,7 +584,7 @@ </dt> <dd> <p> - Forces gfi to close the current packfile, generate its + Forces fast-import to close the current packfile, generate its unique SHA-1 checksum and index, and start a new packfile. This command is optional and is not needed to perform an import. @@ -611,7 +612,7 @@ <tt>refs/heads/RELENG-1_0</tt> for the value of <tt><ref></tt>. The value of <tt><ref></tt> must be a valid refname in Git. As <tt>LF</tt> is not valid in a Git refname, no quoting or escaping syntax is supported here.</p> -<p>A <tt>mark</tt> command may optionally appear, requesting gfi to save a +<p>A <tt>mark</tt> command may optionally appear, requesting fast-import to save a reference to the newly created commit for future use by the frontend (see below for format). It is very common for frontends to mark every commit they create, thereby allowing future branch creation @@ -620,7 +621,7 @@ message (see below for <tt>data</tt> command syntax). To import an empty commit message use a 0 length data. Commit messages are free-form and are not interpreted by Git. Currently they must be encoded in -UTF-8, as gfi does not permit other encodings to be specified.</p> +UTF-8, as fast-import does not permit other encodings to be specified.</p> <p>Zero or more <tt>filemodify</tt>, <tt>filedelete</tt> and <tt>filedeleteall</tt> commands may be included to update the contents of the branch prior to creating the commit. These commands may be supplied in any order. @@ -630,7 +631,7 @@ <h4><tt>author</tt></h4> <p>An <tt>author</tt> command may optionally appear, if the author information might differ from the committer information. If <tt>author</tt> is omitted -then gfi will automatically use the committer's information for +then fast-import will automatically use the committer's information for the author portion of the commit. See below for a description of the fields in <tt>author</tt>, as they are identical to <tt>committer</tt>.</p> <h4><tt>committer</tt></h4> @@ -649,11 +650,11 @@ their syntax.</p> <h4><tt>from</tt></h4> <p>Only valid for the first commit made on this branch by this -gfi process. The <tt>from</tt> command is used to specify the commit +fast-import process. The <tt>from</tt> command is used to specify the commit to initialize this branch from. This revision will be the first ancestor of the new commit.</p> <p>Omitting the <tt>from</tt> command in the first commit of a new branch will -cause gfi to create that commit with no ancestor. This tends to be +cause fast-import to create that commit with no ancestor. This tends to be desired only for the initial commit of a project. Omitting the <tt>from</tt> command on existing branches is required, as the current commit on that branch is automatically assumed to be the first @@ -664,8 +665,8 @@ <ul> <li> <p> -The name of an existing branch already in gfi's internal branch - table. If gfi doesn't know the name, its treated as a SHA-1 +The name of an existing branch already in fast-import's internal branch + table. If fast-import doesn't know the name, its treated as a SHA-1 expression. </p> </li> @@ -673,7 +674,7 @@ <p> A mark reference, <tt>:<idnum></tt>, where <tt><idnum></tt> is the mark number. </p> -<p>The reason gfi uses <tt>:</tt> to denote a mark reference is this character +<p>The reason fast-import uses <tt>:</tt> to denote a mark reference is this character is not legal in a Git branch name. The leading <tt>:</tt> makes it easy to distingush between the mark 42 (<tt>:42</tt>) and the branch 42 (<tt>42</tt> or <tt>refs/heads/42</tt>), or an abbreviated SHA-1 which happened to @@ -698,16 +699,16 @@ <div class="content"> <pre><tt> from refs/heads/branch^0</tt></pre> </div></div> -<p>The <tt>^0</tt> suffix is necessary as gfi does not permit a branch to +<p>The <tt>^0</tt> suffix is necessary as fast-import does not permit a branch to start from itself, and the branch is created in memory before the <tt>from</tt> command is even read from the input. Adding <tt>^0</tt> will force -gfi to resolve the commit through Git's revision parsing library, +fast-import to resolve the commit through Git's revision parsing library, rather than its internal branch table, thereby loading in the existing value of the branch.</p> <h4><tt>merge</tt></h4> <p>Includes one additional ancestor commit, and makes the current commit a merge commit. An unlimited number of <tt>merge</tt> commands per -commit are permitted by gfi, thereby establishing an n-way merge. +commit are permitted by fast-import, thereby establishing an n-way merge. However Git's other tools never create commits with more than 15 additional ancestors (forming a 16-way merge). For this reason it is suggested that frontends do not use more than 15 <tt>merge</tt> @@ -832,12 +833,12 @@ <p>Issuing a <tt>filedeleteall</tt> followed by the needed <tt>filemodify</tt> commands to set the correct content will produce the same results as sending only the needed <tt>filemodify</tt> and <tt>filedelete</tt> commands. -The <tt>filedeleteall</tt> approach may however require gfi to use slightly +The <tt>filedeleteall</tt> approach may however require fast-import to use slightly more memory per active branch (less than 1 MiB for even most large projects); so frontends that can easily obtain only the affected paths for a commit are encouraged to do so.</p> <h3><tt>mark</tt></h3> -<p>Arranges for gfi to save a reference to the current object, allowing +<p>Arranges for fast-import to save a reference to the current object, allowing the frontend to recall this object at a future point in time, without knowing its SHA-1. Here the current object is the object creation command the <tt>mark</tt> command appears within. This can be <tt>commit</tt>, @@ -867,7 +868,7 @@ <p>where <tt><name></tt> is the name of the tag to create.</p> <p>Tag names are automatically prefixed with <tt>refs/tags/</tt> when stored in Git, so importing the CVS branch symbol <tt>RELENG-1_0-FINAL</tt> would -use just <tt>RELENG-1_0-FINAL</tt> for <tt><name></tt>, and gfi will write the +use just <tt>RELENG-1_0-FINAL</tt> for <tt><name></tt>, and fast-import will write the corresponding ref as <tt>refs/tags/RELENG-1_0-FINAL</tt>.</p> <p>The value of <tt><name></tt> must be a valid refname in Git and therefore may contain forward slashes. As <tt>LF</tt> is not valid in a Git refname, @@ -880,12 +881,12 @@ message (see below for <tt>data</tt> command syntax). To import an empty tag message use a 0 length data. Tag messages are free-form and are not interpreted by Git. Currently they must be encoded in UTF-8, -as gfi does not permit other encodings to be specified.</p> -<p>Signing annotated tags during import from within gfi is not +as fast-import does not permit other encodings to be specified.</p> +<p>Signing annotated tags during import from within fast-import is not supported. Trying to include your own PGP/GPG signature is not recommended, as the frontend does not (easily) have access to the complete set of bytes which normally goes into such a signature. -If signing is required, create lightweight tags from within gfi with +If signing is required, create lightweight tags from within fast-import with <tt>reset</tt>, then create the annotated versions of those tags offline with the standard <a href="git-tag.html">git-tag(1)</a> process.</p> <h3><tt>reset</tt></h3> @@ -930,11 +931,11 @@ however, as marks are inexpensive to store and easy to use.</p> <h3><tt>data</tt></h3> <p>Supplies raw data (for use as blob/file content, commit messages, or -annotated tag messages) to gfi. Data can be supplied using an exact +annotated tag messages) to fast-import. Data can be supplied using an exact byte count or delimited with a terminating line. Real frontends intended for production-quality conversions should always use the exact byte count format, as it is more robust and performs better. -The delimited format is intended primarily for testing gfi.</p> +The delimited format is intended primarily for testing fast-import.</p> <dl> <dt> Exact byte count format @@ -959,7 +960,7 @@ <dd> <p> A delimiter string is used to mark the end of the data. - gfi will compute the length by searching for the delimiter. + fast-import will compute the length by searching for the delimiter. This format is primarly useful for testing and is not recommended for real data. </p> @@ -971,23 +972,23 @@ </div></div> <p>where <tt><delim></tt> is the chosen delimiter string. The string <tt><delim></tt> must not appear on a line by itself within <tt><raw></tt>, as otherwise -gfi will think the data ends earlier than it really does. The <tt>LF</tt> +fast-import will think the data ends earlier than it really does. The <tt>LF</tt> immediately trailing <tt><raw></tt> is part of <tt><raw></tt>. This is one of the limitations of the delimited format, it is impossible to supply a data chunk which does not have an LF as its last byte.</p> </dd> </dl> <h3><tt>checkpoint</tt></h3> -<p>Forces gfi to close the current packfile, start a new one, and to +<p>Forces fast-import to close the current packfile, start a new one, and to save out all current branch refs, tags and marks.</p> <div class="literalblock"> <div class="content"> <pre><tt> 'checkpoint' LF LF</tt></pre> </div></div> -<p>Note that gfi automatically switches packfiles when the current +<p>Note that fast-import automatically switches packfiles when the current packfile reaches --max-pack-size, or 4 GiB, whichever limit is -smaller. During an automatic packfile switch gfi does not update +smaller. During an automatic packfile switch fast-import does not update the branch refs, tags or marks.</p> <p>As a <tt>checkpoint</tt> can require a significant amount of CPU time and disk IO (to compute the overall pack SHA-1 checksum, generate the @@ -996,30 +997,30 @@ <p>Frontends may choose to issue checkpoints during extremely large and long running imports, or when they need to allow another Git process access to a branch. However given that a 30 GiB Subversion -repository can be loaded into Git through gfi in about 3 hours, +repository can be loaded into Git through fast-import in about 3 hours, explicit checkpointing may not be necessary.</p> </div> <h2>Tips and Tricks</h2> <div class="sectionbody"> <p>The following tips and tricks have been collected from various -users of gfi, and are offered here as suggestions.</p> +users of fast-import, and are offered here as suggestions.</p> <h3>Use One Mark Per Commit</h3> <p>When doing a repository conversion, use a unique mark per commit (<tt>mark :<n></tt>) and supply the --export-marks option on the command -line. gfi will dump a file which lists every mark and the Git +line. fast-import will dump a file which lists every mark and the Git object SHA-1 that corresponds to it. If the frontend can tie the marks back to the source repository, it is easy to verify the accuracy and completeness of the import by comparing each Git commit to the corresponding source revision.</p> <p>Coming from a system such as Perforce or Subversion this should be -quite simple, as the gfi mark can also be the Perforce changeset +quite simple, as the fast-import mark can also be the Perforce changeset number or the Subversion revision number.</p> <h3>Freely Skip Around Branches</h3> <p>Don't bother trying to optimize the frontend to stick to one branch at a time during an import. Although doing so might be slightly -faster for gfi, it tends to increase the complexity of the frontend +faster for fast-import, it tends to increase the complexity of the frontend code considerably.</p> -<p>The branch LRU builtin to gfi tends to behave very well, and the +<p>The branch LRU builtin to fast-import tends to behave very well, and the cost of activating an inactive branch is so low that bouncing around between branches has virtually no impact on import performance.</p> <h3>Use Tag Fixup Branches</h3> @@ -1028,7 +1029,7 @@ tags which are a subset of the files available in the repository.</p> <p>Importing these tags as-is in Git is impossible without making at least one commit which “fixes up” the files to match the content -of the tag. Use gfi's <tt>reset</tt> command to reset a dummy branch +of the tag. Use fast-import's <tt>reset</tt> command to reset a dummy branch outside of your normal branch space to the base commit for the tag, then commit one or more file fixup commits, and finally tag the dummy branch.</p> @@ -1042,10 +1043,10 @@ Doing so will allow tools such as <a href="git-blame.html">git-blame(1)</a> to track through the real commit history and properly annotate the source files.</p> -<p>After gfi terminates the frontend will need to do <tt>rm .git/TAG_FIXUP</tt> +<p>After fast-import terminates the frontend will need to do <tt>rm .git/TAG_FIXUP</tt> to remove the dummy branch.</p> <h3>Import Now, Repack Later</h3> -<p>As soon as gfi completes the Git repository is completely valid +<p>As soon as fast-import completes the Git repository is completely valid and ready for use. Typicallly this takes only a very short time, even for considerably large projects (100,000+ commits).</p> <p>However repacking the repository is necessary to improve data @@ -1055,7 +1056,7 @@ run the repack in the background and let it finish when it finishes. There is no reason to wait to explore your new Git project!</p> <p>If you choose to wait for the repack, don't try to run benchmarks -or performance tests until repacking is completed. gfi outputs +or performance tests until repacking is completed. fast-import outputs suboptimal packfiles that are simply never seen in real use situations.</p> <h3>Repacking Historical Data</h3> @@ -1068,7 +1069,7 @@ </div> <h2>Packfile Optimization</h2> <div class="sectionbody"> -<p>When packing a blob gfi always attempts to deltify against the last +<p>When packing a blob fast-import always attempts to deltify against the last blob written. Unless specifically arranged for by the frontend, this will probably not be a prior version of the same file, so the generated delta will not be the smallest possible. The resulting @@ -1076,18 +1077,18 @@ <p>Frontends which have efficient access to all revisions of a single file (for example reading an RCS/CVS ,v file) can choose to supply all revisions of that file as a sequence of consecutive -<tt>blob</tt> commands. This allows gfi to deltify the different file +<tt>blob</tt> commands. This allows fast-import to deltify the different file revisions against each other, saving space in the final packfile. Marks can be used to later identify individual file revisions during a sequence of <tt>commit</tt> commands.</p> -<p>The packfile(s) created by gfi do not encourage good disk access -patterns. This is caused by gfi writing the data in the order +<p>The packfile(s) created by fast-import do not encourage good disk access +patterns. This is caused by fast-import writing the data in the order it is received on standard input, while Git typically organizes data within packfiles to make the most recent (current tip) data appear before historical data. Git also clusters commits together, speeding up revision traversal through better cache locality.</p> <p>For this reason it is strongly recommended that users repack the -repository with <tt>git repack -a -d</tt> after gfi completes, allowing +repository with <tt>git repack -a -d</tt> after fast-import completes, allowing Git to reorganize the packfiles for faster data access. If blob deltas are suboptimal (see above) then also adding the <tt>-f</tt> option to force recomputation of all deltas can significantly reduce the @@ -1095,20 +1096,20 @@ </div> <h2>Memory Utilization</h2> <div class="sectionbody"> -<p>There are a number of factors which affect how much memory gfi +<p>There are a number of factors which affect how much memory fast-import requires to perform an import. Like critical sections of core -Git, gfi uses its own memory allocators to ammortize any overheads -associated with malloc. In practice gfi tends to ammoritize any +Git, fast-import uses its own memory allocators to ammortize any overheads +associated with malloc. In practice fast-import tends to ammoritize any malloc overheads to 0, due to its use of large block allocations.</p> <h3>per object</h3> -<p>gfi maintains an in-memory structure for every object written in +<p>fast-import maintains an in-memory structure for every object written in this execution. On a 32 bit system the structure is 32 bytes, on a 64 bit system the structure is 40 bytes (due to the larger pointer sizes). Objects in the table are not deallocated until -gfi terminates. Importing 2 million objects on a 32 bit system +fast-import terminates. Importing 2 million objects on a 32 bit system will require approximately 64 MiB of memory.</p> <p>The object table is actually a hashtable keyed on the object name -(the unique SHA-1). This storage configuration allows gfi to reuse +(the unique SHA-1). This storage configuration allows fast-import to reuse an existing or already written object and avoid writing duplicates to the output packfile. Duplicate blobs are surprisingly common in an import, typically due to branch merges in the source.</p> @@ -1123,7 +1124,7 @@ of the two classes is significantly different.</p> <p>Inactive branches are stored in a structure which uses 96 or 120 bytes (32 bit or 64 bit systems, respectively), plus the length of -the branch name (typically under 200 bytes), per branch. gfi will +the branch name (typically under 200 bytes), per branch. fast-import will easily handle as many as 10,000 inactive branches in under 2 MiB of memory.</p> <p>Active branches have the same overhead as inactive branches, but @@ -1135,7 +1136,7 @@ <p>As active branches store metadata about the files contained on that branch, their in-memory storage size can grow to a considerable size (see below).</p> -<p>gfi automatically moves active branches to inactive status based on +<p>fast-import automatically moves active branches to inactive status based on a simple least-recently-used algorithm. The LRU chain is updated on each <tt>commit</tt> command. The maximum number of active branches can be increased or decreased on the command line with --active-branches=.</p> @@ -1151,7 +1152,7 @@ “Makefile” to use just 16 bytes (after including the string header overhead) no matter how many times it occurs within the project.</p> <p>The active branch LRU, when coupled with the filename string pool -and lazy loading of subtrees, allows gfi to efficiently import +and lazy loading of subtrees, allows fast-import to efficiently import projects with 2,000+ branches and 45,114+ files in a very limited memory footprint (less than 2.7 MiB per active branch).</p> </div> @@ -1169,7 +1170,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 07-Feb-2007 23:17:17 UTC +Last updated 09-Feb-2007 08:38:34 UTC </div> </div> </body>
diff --git a/git-fast-import.txt b/git-fast-import.txt index 0b64d33..2a50520 100644 --- a/git-fast-import.txt +++ b/git-fast-import.txt
@@ -15,15 +15,15 @@ This program is usually not what the end user wants to run directly. Most end users want to use one of the existing frontend programs, which parses a specific type of foreign source and feeds the contents -stored there to git-fast-import (gfi). +stored there to git-fast-import. -gfi reads a mixed command/data stream from standard input and +fast-import reads a mixed command/data stream from standard input and writes one or more packfiles directly into the current repository. When EOF is received on standard input, fast import writes out updated branch and tag refs, fully updating the current repository with the newly imported data. -The gfi backend itself can import into an empty repository (one that +The fast-import backend itself can import into an empty repository (one that has already been initialized by gitlink:git-init[1]) or incrementally update an existing populated repository. Whether or not incremental imports are supported from a particular foreign source depends on @@ -34,7 +34,7 @@ ------- --date-format=<fmt>:: Specify the type of dates the frontend will supply to - gfi within `author`, `committer` and `tagger` commands. + fast-import within `author`, `committer` and `tagger` commands. See ``Date Formats'' below for details about which formats are supported, and their syntax. @@ -65,28 +65,28 @@ have been completed. --quiet:: - Disable all non-fatal output, making gfi silent when it + Disable all non-fatal output, making fast-import silent when it is successful. This option disables the output shown by \--stats. --stats:: - Display some basic statistics about the objects gfi has + Display some basic statistics about the objects fast-import has created, the packfiles they were stored into, and the - memory used by gfi during this run. Showing this output + memory used by fast-import during this run. Showing this output is currently the default, but can be disabled with \--quiet. Performance ----------- -The design of gfi allows it to import large projects in a minimum +The design of fast-import allows it to import large projects in a minimum amount of memory usage and processing time. Assuming the frontend -is able to keep up with gfi and feed it a constant stream of data, +is able to keep up with fast-import and feed it a constant stream of data, import times for projects holding 10+ years of history and containing 100,000+ individual commits are generally completed in just 1-2 hours on quite modest (~$2,000 USD) hardware. Most bottlenecks appear to be in foreign source data access (the -source just cannot extract revisions fast enough) or disk IO (gfi +source just cannot extract revisions fast enough) or disk IO (fast-import writes as fast as the disk will take the data). Imports will run faster if the source data is stored on a different drive than the destination Git repository (due to less IO contention). @@ -94,28 +94,28 @@ Development Cost ---------------- -A typical frontend for gfi tends to weigh in at approximately 200 +A typical frontend for fast-import tends to weigh in at approximately 200 lines of Perl/Python/Ruby code. Most developers have been able to create working importers in just a couple of hours, even though it -is their first exposure to gfi, and sometimes even to Git. This is +is their first exposure to fast-import, and sometimes even to Git. This is an ideal situation, given that most conversion tools are throw-away (use once, and never look back). Parallel Operation ------------------ -Like `git-push` or `git-fetch`, imports handled by gfi are safe to +Like `git-push` or `git-fetch`, imports handled by fast-import are safe to run alongside parallel `git repack -a -d` or `git gc` invocations, or any other Git operation (including `git prune`, as loose objects -are never used by gfi). +are never used by fast-import). -gfi does not lock the branch or tag refs it is actively importing. -After the import, during its ref update phase, gfi tests each +fast-import does not lock the branch or tag refs it is actively importing. +After the import, during its ref update phase, fast-import tests each existing branch ref to verify the update will be a fast-forward update (the commit stored in the ref is contained in the new history of the commit to be written). If the update is not a -fast-forward update, gfi will skip updating that ref and instead -prints a warning message. gfi will always attempt to update all +fast-forward update, fast-import will skip updating that ref and instead +prints a warning message. fast-import will always attempt to update all branch refs, and does not stop on the first failure. Branch updates can be forced with \--force, but its recommended that @@ -125,35 +125,35 @@ Technical Discussion -------------------- -gfi tracks a set of branches in memory. Any branch can be created +fast-import tracks a set of branches in memory. Any branch can be created or modified at any point during the import process by sending a `commit` command on the input stream. This design allows a frontend program to process an unlimited number of branches simultaneously, generating commits in the order they are available from the source data. It also simplifies the frontend programs considerably. -gfi does not use or alter the current working directory, or any +fast-import does not use or alter the current working directory, or any file within it. (It does however update the current Git repository, as referenced by `GIT_DIR`.) Therefore an import frontend may use the working directory for its own purposes, such as extracting file revisions from the foreign source. This ignorance of the working -directory also allows gfi to run very quickly, as it does not +directory also allows fast-import to run very quickly, as it does not need to perform any costly file update operations when switching between branches. Input Format ------------ With the exception of raw file data (which Git does not interpret) -the gfi input format is text (ASCII) based. This text based +the fast-import input format is text (ASCII) based. This text based format simplifies development and debugging of frontend programs, especially when a higher level language such as Perl, Python or Ruby is being used. -gfi is very strict about its input. Where we say SP below we mean +fast-import is very strict about its input. Where we say SP below we mean *exactly* one space. Likewise LF means one (and only one) linefeed. Supplying additional whitespace characters will cause unexpected results, such as branch names or file names with leading or trailing -spaces in their name, or early termination of gfi when it encounters +spaces in their name, or early termination of fast-import when it encounters unexpected input. Date Formats @@ -164,7 +164,7 @@ `raw`:: This is the Git native format and is `<time> SP <offutc>`. - It is also gfi's default format, if \--date-format was + It is also fast-import's default format, if \--date-format was not specified. + The time of the event is specified by `<time>` as the number of @@ -181,16 +181,16 @@ ``+0000'', or the most common local offset. For example many organizations have a CVS repository which has only ever been accessed by users who are located in the same location and timezone. In this -case the offset from UTC can be easily assumed. +case a reasonable offset from UTC could be assumed. + Unlike the `rfc2822` format, this format is very strict. Any -variation in formatting will cause gfi to reject the value. +variation in formatting will cause fast-import to reject the value. `rfc2822`:: This is the standard email format as described by RFC 2822. + An example value is ``Tue Feb 6 11:22:18 2007 -0500''. The Git -parser is accurate, but a little on the lenient side. Its the +parser is accurate, but a little on the lenient side. It is the same parser used by gitlink:git-am[1] when applying patches received from email. + @@ -205,14 +205,15 @@ value to UTC prior to storage. Therefore it is important that this information be as accurate as possible. + -If the source material is formatted in RFC 2822 style dates, -the frontend should let gfi handle the parsing and conversion +If the source material uses RFC 2822 style dates, +the frontend should let fast-import handle the parsing and conversion (rather than attempting to do it itself) as the Git parser has been well tested in the wild. + Frontends should prefer the `raw` format if the source material -is already in UNIX-epoch format, or is easily convertible to -that format, as there is no ambiguity in parsing. +already uses UNIX-epoch format, can be coaxed to give dates in that +format, or its format is easiliy convertible to it, as there is no +ambiguity in parsing. `now`:: Always use the current time and timezone. The literal @@ -220,7 +221,7 @@ + This is a toy format. The current time and timezone of this system is always copied into the identity string at the time it is being -created by gfi. There is no way to specify a different time or +created by fast-import. There is no way to specify a different time or timezone. + This particular format is supplied as its short to implement and @@ -237,7 +238,7 @@ Commands ~~~~~~~~ -gfi accepts several commands to update the current repository +fast-import accepts several commands to update the current repository and control the current import process. More detailed discussion (with examples) of each command follows later. @@ -263,7 +264,7 @@ needed to perform an import. `checkpoint`:: - Forces gfi to close the current packfile, generate its + Forces fast-import to close the current packfile, generate its unique SHA-1 checksum and index, and start a new packfile. This command is optional and is not needed to perform an import. @@ -292,7 +293,7 @@ `<ref>` must be a valid refname in Git. As `LF` is not valid in a Git refname, no quoting or escaping syntax is supported here. -A `mark` command may optionally appear, requesting gfi to save a +A `mark` command may optionally appear, requesting fast-import to save a reference to the newly created commit for future use by the frontend (see below for format). It is very common for frontends to mark every commit they create, thereby allowing future branch creation @@ -302,7 +303,7 @@ message (see below for `data` command syntax). To import an empty commit message use a 0 length data. Commit messages are free-form and are not interpreted by Git. Currently they must be encoded in -UTF-8, as gfi does not permit other encodings to be specified. +UTF-8, as fast-import does not permit other encodings to be specified. Zero or more `filemodify`, `filedelete` and `filedeleteall` commands may be included to update the contents of the branch prior to @@ -315,7 +316,7 @@ ^^^^^^^^ An `author` command may optionally appear, if the author information might differ from the committer information. If `author` is omitted -then gfi will automatically use the committer's information for +then fast-import will automatically use the committer's information for the author portion of the commit. See below for a description of the fields in `author`, as they are identical to `committer`. @@ -340,12 +341,12 @@ `from` ^^^^^^ Only valid for the first commit made on this branch by this -gfi process. The `from` command is used to specify the commit +fast-import process. The `from` command is used to specify the commit to initialize this branch from. This revision will be the first ancestor of the new commit. Omitting the `from` command in the first commit of a new branch will -cause gfi to create that commit with no ancestor. This tends to be +cause fast-import to create that commit with no ancestor. This tends to be desired only for the initial commit of a project. Omitting the `from` command on existing branches is required, as the current commit on that branch is automatically assumed to be the first @@ -356,13 +357,13 @@ Here `<committish>` is any of the following: -* The name of an existing branch already in gfi's internal branch - table. If gfi doesn't know the name, its treated as a SHA-1 +* The name of an existing branch already in fast-import's internal branch + table. If fast-import doesn't know the name, its treated as a SHA-1 expression. * A mark reference, `:<idnum>`, where `<idnum>` is the mark number. + -The reason gfi uses `:` to denote a mark reference is this character +The reason fast-import uses `:` to denote a mark reference is this character is not legal in a Git branch name. The leading `:` makes it easy to distingush between the mark 42 (`:42`) and the branch 42 (`42` or `refs/heads/42`), or an abbreviated SHA-1 which happened to @@ -380,10 +381,10 @@ ---- from refs/heads/branch^0 ---- -The `^0` suffix is necessary as gfi does not permit a branch to +The `{caret}0` suffix is necessary as fast-import does not permit a branch to start from itself, and the branch is created in memory before the -`from` command is even read from the input. Adding `^0` will force -gfi to resolve the commit through Git's revision parsing library, +`from` command is even read from the input. Adding `{caret}0` will force +fast-import to resolve the commit through Git's revision parsing library, rather than its internal branch table, thereby loading in the existing value of the branch. @@ -391,7 +392,7 @@ ^^^^^^^ Includes one additional ancestor commit, and makes the current commit a merge commit. An unlimited number of `merge` commands per -commit are permitted by gfi, thereby establishing an n-way merge. +commit are permitted by fast-import, thereby establishing an n-way merge. However Git's other tools never create commits with more than 15 additional ancestors (forming a 16-way merge). For this reason it is suggested that frontends do not use more than 15 `merge` @@ -492,14 +493,14 @@ Issuing a `filedeleteall` followed by the needed `filemodify` commands to set the correct content will produce the same results as sending only the needed `filemodify` and `filedelete` commands. -The `filedeleteall` approach may however require gfi to use slightly +The `filedeleteall` approach may however require fast-import to use slightly more memory per active branch (less than 1 MiB for even most large projects); so frontends that can easily obtain only the affected paths for a commit are encouraged to do so. `mark` ~~~~~~ -Arranges for gfi to save a reference to the current object, allowing +Arranges for fast-import to save a reference to the current object, allowing the frontend to recall this object at a future point in time, without knowing its SHA-1. Here the current object is the object creation command the `mark` command appears within. This can be `commit`, @@ -535,7 +536,7 @@ Tag names are automatically prefixed with `refs/tags/` when stored in Git, so importing the CVS branch symbol `RELENG-1_0-FINAL` would -use just `RELENG-1_0-FINAL` for `<name>`, and gfi will write the +use just `RELENG-1_0-FINAL` for `<name>`, and fast-import will write the corresponding ref as `refs/tags/RELENG-1_0-FINAL`. The value of `<name>` must be a valid refname in Git and therefore @@ -552,13 +553,13 @@ message (see below for `data` command syntax). To import an empty tag message use a 0 length data. Tag messages are free-form and are not interpreted by Git. Currently they must be encoded in UTF-8, -as gfi does not permit other encodings to be specified. +as fast-import does not permit other encodings to be specified. -Signing annotated tags during import from within gfi is not +Signing annotated tags during import from within fast-import is not supported. Trying to include your own PGP/GPG signature is not recommended, as the frontend does not (easily) have access to the complete set of bytes which normally goes into such a signature. -If signing is required, create lightweight tags from within gfi with +If signing is required, create lightweight tags from within fast-import with `reset`, then create the annotated versions of those tags offline with the standard gitlink:git-tag[1] process. @@ -610,11 +611,11 @@ `data` ~~~~~~ Supplies raw data (for use as blob/file content, commit messages, or -annotated tag messages) to gfi. Data can be supplied using an exact +annotated tag messages) to fast-import. Data can be supplied using an exact byte count or delimited with a terminating line. Real frontends intended for production-quality conversions should always use the exact byte count format, as it is more robust and performs better. -The delimited format is intended primarily for testing gfi. +The delimited format is intended primarily for testing fast-import. Exact byte count format:: The frontend must specify the number of bytes of data. @@ -631,7 +632,7 @@ Delimited format:: A delimiter string is used to mark the end of the data. - gfi will compute the length by searching for the delimiter. + fast-import will compute the length by searching for the delimiter. This format is primarly useful for testing and is not recommended for real data. + @@ -643,14 +644,14 @@ + where `<delim>` is the chosen delimiter string. The string `<delim>` must not appear on a line by itself within `<raw>`, as otherwise -gfi will think the data ends earlier than it really does. The `LF` +fast-import will think the data ends earlier than it really does. The `LF` immediately trailing `<raw>` is part of `<raw>`. This is one of the limitations of the delimited format, it is impossible to supply a data chunk which does not have an LF as its last byte. `checkpoint` ~~~~~~~~~~~~ -Forces gfi to close the current packfile, start a new one, and to +Forces fast-import to close the current packfile, start a new one, and to save out all current branch refs, tags and marks. .... @@ -658,9 +659,9 @@ LF .... -Note that gfi automatically switches packfiles when the current +Note that fast-import automatically switches packfiles when the current packfile reaches \--max-pack-size, or 4 GiB, whichever limit is -smaller. During an automatic packfile switch gfi does not update +smaller. During an automatic packfile switch fast-import does not update the branch refs, tags or marks. As a `checkpoint` can require a significant amount of CPU time and @@ -671,37 +672,37 @@ Frontends may choose to issue checkpoints during extremely large and long running imports, or when they need to allow another Git process access to a branch. However given that a 30 GiB Subversion -repository can be loaded into Git through gfi in about 3 hours, +repository can be loaded into Git through fast-import in about 3 hours, explicit checkpointing may not be necessary. Tips and Tricks --------------- The following tips and tricks have been collected from various -users of gfi, and are offered here as suggestions. +users of fast-import, and are offered here as suggestions. Use One Mark Per Commit ~~~~~~~~~~~~~~~~~~~~~~~ When doing a repository conversion, use a unique mark per commit (`mark :<n>`) and supply the \--export-marks option on the command -line. gfi will dump a file which lists every mark and the Git +line. fast-import will dump a file which lists every mark and the Git object SHA-1 that corresponds to it. If the frontend can tie the marks back to the source repository, it is easy to verify the accuracy and completeness of the import by comparing each Git commit to the corresponding source revision. Coming from a system such as Perforce or Subversion this should be -quite simple, as the gfi mark can also be the Perforce changeset +quite simple, as the fast-import mark can also be the Perforce changeset number or the Subversion revision number. Freely Skip Around Branches ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Don't bother trying to optimize the frontend to stick to one branch at a time during an import. Although doing so might be slightly -faster for gfi, it tends to increase the complexity of the frontend +faster for fast-import, it tends to increase the complexity of the frontend code considerably. -The branch LRU builtin to gfi tends to behave very well, and the +The branch LRU builtin to fast-import tends to behave very well, and the cost of activating an inactive branch is so low that bouncing around between branches has virtually no impact on import performance. @@ -713,7 +714,7 @@ Importing these tags as-is in Git is impossible without making at least one commit which ``fixes up'' the files to match the content -of the tag. Use gfi's `reset` command to reset a dummy branch +of the tag. Use fast-import's `reset` command to reset a dummy branch outside of your normal branch space to the base commit for the tag, then commit one or more file fixup commits, and finally tag the dummy branch. @@ -730,12 +731,12 @@ through the real commit history and properly annotate the source files. -After gfi terminates the frontend will need to do `rm .git/TAG_FIXUP` +After fast-import terminates the frontend will need to do `rm .git/TAG_FIXUP` to remove the dummy branch. Import Now, Repack Later ~~~~~~~~~~~~~~~~~~~~~~~~ -As soon as gfi completes the Git repository is completely valid +As soon as fast-import completes the Git repository is completely valid and ready for use. Typicallly this takes only a very short time, even for considerably large projects (100,000+ commits). @@ -747,7 +748,7 @@ There is no reason to wait to explore your new Git project! If you choose to wait for the repack, don't try to run benchmarks -or performance tests until repacking is completed. gfi outputs +or performance tests until repacking is completed. fast-import outputs suboptimal packfiles that are simply never seen in real use situations. @@ -763,7 +764,7 @@ Packfile Optimization --------------------- -When packing a blob gfi always attempts to deltify against the last +When packing a blob fast-import always attempts to deltify against the last blob written. Unless specifically arranged for by the frontend, this will probably not be a prior version of the same file, so the generated delta will not be the smallest possible. The resulting @@ -772,20 +773,20 @@ Frontends which have efficient access to all revisions of a single file (for example reading an RCS/CVS ,v file) can choose to supply all revisions of that file as a sequence of consecutive -`blob` commands. This allows gfi to deltify the different file +`blob` commands. This allows fast-import to deltify the different file revisions against each other, saving space in the final packfile. Marks can be used to later identify individual file revisions during a sequence of `commit` commands. -The packfile(s) created by gfi do not encourage good disk access -patterns. This is caused by gfi writing the data in the order +The packfile(s) created by fast-import do not encourage good disk access +patterns. This is caused by fast-import writing the data in the order it is received on standard input, while Git typically organizes data within packfiles to make the most recent (current tip) data appear before historical data. Git also clusters commits together, speeding up revision traversal through better cache locality. For this reason it is strongly recommended that users repack the -repository with `git repack -a -d` after gfi completes, allowing +repository with `git repack -a -d` after fast-import completes, allowing Git to reorganize the packfiles for faster data access. If blob deltas are suboptimal (see above) then also adding the `-f` option to force recomputation of all deltas can significantly reduce the @@ -794,23 +795,23 @@ Memory Utilization ------------------ -There are a number of factors which affect how much memory gfi +There are a number of factors which affect how much memory fast-import requires to perform an import. Like critical sections of core -Git, gfi uses its own memory allocators to ammortize any overheads -associated with malloc. In practice gfi tends to ammoritize any +Git, fast-import uses its own memory allocators to ammortize any overheads +associated with malloc. In practice fast-import tends to ammoritize any malloc overheads to 0, due to its use of large block allocations. per object ~~~~~~~~~~ -gfi maintains an in-memory structure for every object written in +fast-import maintains an in-memory structure for every object written in this execution. On a 32 bit system the structure is 32 bytes, on a 64 bit system the structure is 40 bytes (due to the larger pointer sizes). Objects in the table are not deallocated until -gfi terminates. Importing 2 million objects on a 32 bit system +fast-import terminates. Importing 2 million objects on a 32 bit system will require approximately 64 MiB of memory. The object table is actually a hashtable keyed on the object name -(the unique SHA-1). This storage configuration allows gfi to reuse +(the unique SHA-1). This storage configuration allows fast-import to reuse an existing or already written object and avoid writing duplicates to the output packfile. Duplicate blobs are surprisingly common in an import, typically due to branch merges in the source. @@ -830,7 +831,7 @@ Inactive branches are stored in a structure which uses 96 or 120 bytes (32 bit or 64 bit systems, respectively), plus the length of -the branch name (typically under 200 bytes), per branch. gfi will +the branch name (typically under 200 bytes), per branch. fast-import will easily handle as many as 10,000 inactive branches in under 2 MiB of memory. @@ -845,7 +846,7 @@ branch, their in-memory storage size can grow to a considerable size (see below). -gfi automatically moves active branches to inactive status based on +fast-import automatically moves active branches to inactive status based on a simple least-recently-used algorithm. The LRU chain is updated on each `commit` command. The maximum number of active branches can be increased or decreased on the command line with \--active-branches=. @@ -866,7 +867,7 @@ overhead) no matter how many times it occurs within the project. The active branch LRU, when coupled with the filename string pool -and lazy loading of subtrees, allows gfi to efficiently import +and lazy loading of subtrees, allows fast-import to efficiently import projects with 2,000+ branches and 45,114+ files in a very limited memory footprint (less than 2.7 MiB per active branch). diff --git a/git-log.html b/git-log.html index 5804b56..431cf4d 100644 --- a/git-log.html +++ b/git-log.html
@@ -279,7 +279,7 @@ <p>Shows the commit logs.</p> <p>The command takes options applicable to the <a href="git-rev-list.html">git-rev-list(1)</a> command to control what is shown and how, and options applicable to -the <a href="git-diff-tree.html">git-diff-tree(1)</a> commands to control how the change +the <a href="git-diff-tree.html">git-diff-tree(1)</a> commands to control how the changes each commit introduces are shown.</p> <p>This manual page describes only the most frequently used options.</p> </div> @@ -598,7 +598,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 18-Jan-2007 06:24:00 UTC +Last updated 09-Feb-2007 08:38:35 UTC </div> </div> </body>
diff --git a/git-log.txt b/git-log.txt index b802946..361eaec 100644 --- a/git-log.txt +++ b/git-log.txt
@@ -16,7 +16,7 @@ The command takes options applicable to the gitlink:git-rev-list[1] command to control what is shown and how, and options applicable to -the gitlink:git-diff-tree[1] commands to control how the change +the gitlink:git-diff-tree[1] commands to control how the changes each commit introduces are shown. This manual page describes only the most frequently used options.
diff --git a/git-pull.html b/git-pull.html index 15ff659..d4e8847 100644 --- a/git-pull.html +++ b/git-pull.html
@@ -710,6 +710,63 @@ </dd> </dl> </div> +<h2>DEFAULT BEHAVIOUR</h2> +<div class="sectionbody"> +<p>Often people use <tt>git pull</tt> without giving any parameter. +Traditionally, this has been equivalent to saying <tt>git pull +origin</tt>. However, when configuration <tt>branch.<name>.remote</tt> is +present while on branch <tt><name></tt>, that value is used instead of +<tt>origin</tt>.</p> +<p>In order to determine what URL to use to fetch from, the value +of the configuration <tt>remote.<origin>.url</tt> is consulted +and if there is not any such variable, the value on <tt>URL: </tt> line +in <tt>$GIT_DIR/remotes/<origin></tt> file is used.</p> +<p>In order to determine what remote branches to fetch (and +optionally store in the tracking branches) when the command is +run without any refspec parameters on the command line, values +of the configuration variable <tt>remote.<origin>.fetch</tt> are +consulted, and if there aren't any, <tt>$GIT_DIR/remotes/<origin></tt> +file is consulted and its <tt>Pull: </tt> lines are used. +In addition to the refspec formats described in the OPTIONS +section, you can have a globbing refspec that looks like this:</p> +<div class="listingblock"> +<div class="content"> +<pre><tt>refs/heads/*:refs/remotes/origin/*</tt></pre> +</div></div> +<p>A globbing refspec must have a non-empty RHS (i.e. must store +what were fetched in tracking branches), and its LHS and RHS +must end with <tt>/*</tt>. The above specifies that all remote +branches are tracked using tracking branches in +<tt>refs/remotes/origin/</tt> hierarchy under the same name.</p> +<p>The rule to determine which remote branch to merge after +fetching is a bit involved, in order not to break backward +compatibility.</p> +<p>If explicit refspecs were given on the command +line of <tt>git pull</tt>, they are all merged.</p> +<p>When no refspec was given on the command line, then <tt>git pull</tt> +uses the refspec from the configuration or +<tt>$GIT_DIR/remotes/<origin></tt>. In such cases, the following +rules apply:</p> +<ol> +<li> +<p> +If <tt>branch.<name>.merge</tt> configuration for the current + branch <tt><name></tt> exists, that is the name of the branch at the + remote site that is merged. +</p> +</li> +<li> +<p> +If the refspec is a globbing one, nothing is merged. +</p> +</li> +<li> +<p> +Otherwise the remote branch of the first refspec is merged. +</p> +</li> +</ol> +</div> <h2>EXAMPLES</h2> <div class="sectionbody"> <dl> @@ -813,7 +870,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 29-Jan-2007 02:55:09 UTC +Last updated 09-Feb-2007 08:38:36 UTC </div> </div> </body>
diff --git a/git-pull.txt b/git-pull.txt index a81d68c..94478ed 100644 --- a/git-pull.txt +++ b/git-pull.txt
@@ -33,6 +33,60 @@ include::merge-strategies.txt[] +DEFAULT BEHAVIOUR +----------------- + +Often people use `git pull` without giving any parameter. +Traditionally, this has been equivalent to saying `git pull +origin`. However, when configuration `branch.<name>.remote` is +present while on branch `<name>`, that value is used instead of +`origin`. + +In order to determine what URL to use to fetch from, the value +of the configuration `remote.<origin>.url` is consulted +and if there is not any such variable, the value on `URL: ` line +in `$GIT_DIR/remotes/<origin>` file is used. + +In order to determine what remote branches to fetch (and +optionally store in the tracking branches) when the command is +run without any refspec parameters on the command line, values +of the configuration variable `remote.<origin>.fetch` are +consulted, and if there aren't any, `$GIT_DIR/remotes/<origin>` +file is consulted and its `Pull: ` lines are used. +In addition to the refspec formats described in the OPTIONS +section, you can have a globbing refspec that looks like this: + +------------ +refs/heads/*:refs/remotes/origin/* +------------ + +A globbing refspec must have a non-empty RHS (i.e. must store +what were fetched in tracking branches), and its LHS and RHS +must end with `/*`. The above specifies that all remote +branches are tracked using tracking branches in +`refs/remotes/origin/` hierarchy under the same name. + +The rule to determine which remote branch to merge after +fetching is a bit involved, in order not to break backward +compatibility. + +If explicit refspecs were given on the command +line of `git pull`, they are all merged. + +When no refspec was given on the command line, then `git pull` +uses the refspec from the configuration or +`$GIT_DIR/remotes/<origin>`. In such cases, the following +rules apply: + +. If `branch.<name>.merge` configuration for the current + branch `<name>` exists, that is the name of the branch at the + remote site that is merged. + +. If the refspec is a globbing one, nothing is merged. + +. Otherwise the remote branch of the first refspec is merged. + + EXAMPLES --------
diff --git a/git-rebase.html b/git-rebase.html index 5cd948b..fcb907a 100644 --- a/git-rebase.html +++ b/git-rebase.html
@@ -272,7 +272,7 @@ </div> <h2>SYNOPSIS</h2> <div class="sectionbody"> -<p><em>git-rebase</em> [-v] [--merge] [--onto <newbase>] <upstream> [<branch>]</p> +<p><em>git-rebase</em> [-v] [--merge] [-CNUM] [--onto <newbase>] <upstream> [<branch>]</p> <p><em>git-rebase</em> --continue | --skip | --abort</p> </div> <h2>DESCRIPTION</h2> @@ -492,6 +492,17 @@ Display a diffstat of what changed upstream since the last rebase. </p> </dd> +<dt> +-C<n> +</dt> +<dd> +<p> + Ensure at least <n> lines of surrounding context match before + and after each change. When fewer lines of surrounding + context exist they all must match. By default no context is + ever ignored. +</p> +</dd> </dl> </div> <h2>MERGE STRATEGIES</h2> @@ -580,7 +591,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 06-Feb-2007 00:09:25 UTC +Last updated 09-Feb-2007 08:38:36 UTC </div> </div> </body>
diff --git a/git-rebase.txt b/git-rebase.txt index 977f661..3dff2df 100644 --- a/git-rebase.txt +++ b/git-rebase.txt
@@ -7,7 +7,7 @@ SYNOPSIS -------- -'git-rebase' [-v] [--merge] [--onto <newbase>] <upstream> [<branch>] +'git-rebase' [-v] [--merge] [-CNUM] [--onto <newbase>] <upstream> [<branch>] 'git-rebase' --continue | --skip | --abort @@ -196,6 +196,12 @@ -v, \--verbose:: Display a diffstat of what changed upstream since the last rebase. +-C<n>:: + Ensure at least <n> lines of surrounding context match before + and after each change. When fewer lines of surrounding + context exist they all must match. By default no context is + ever ignored. + include::merge-strategies.txt[] NOTES
diff --git a/git-reflog.html b/git-reflog.html index b635ced..66df443 100644 --- a/git-reflog.html +++ b/git-reflog.html
@@ -272,12 +272,16 @@ </div> <h2>SYNOPSIS</h2> <div class="sectionbody"> -<div class="verseblock"> -<div class="content"><em>git-reflog</em> expire [--dry-run] [--stale-fix] - [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>…</div></div> +<p><em>git reflog</em> <subcommand> <options></p> </div> <h2>DESCRIPTION</h2> <div class="sectionbody"> +<p>The command takes various subcommands, and different options +depending on the subcommand:</p> +<div class="verseblock"> +<div class="content">git reflog expire [--dry-run] [--stale-fix] + [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>…</div></div> +<p>git reflog [show] [log-options]</p> <p>Reflog is a mechanism to record when the tip of branches are updated. This command is to manage the information recorded in it.</p> <p>The subcommand "expire" is used to prune older reflog entries. @@ -285,6 +289,10 @@ <tt>expire-unreachable</tt> time and are not reachable from the current tip, are removed from the reflog. This is typically not used directly by the end users — instead, see <a href="git-gc.html">git-gc(1)</a>.</p> +<p>The subcommand "show" (which is also the default, in the absense of any +subcommands) will take all the normal log options, and show the log of +the current branch. It is basically an alias for <em>git log -g --abbrev-commit +--pretty=oneline</em>, see <a href="git-log.html">git-log(1)</a>.</p> </div> <h2>OPTIONS</h2> <div class="sectionbody"> @@ -335,7 +343,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 16-Jan-2007 10:44:38 UTC +Last updated 09-Feb-2007 08:38:37 UTC </div> </div> </body>
diff --git a/git-reflog.txt b/git-reflog.txt index 1138865..1e343bc 100644 --- a/git-reflog.txt +++ b/git-reflog.txt
@@ -8,13 +8,18 @@ SYNOPSIS -------- -[verse] -'git-reflog' expire [--dry-run] [--stale-fix] - [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>... - +'git reflog' <subcommand> <options> DESCRIPTION ----------- +The command takes various subcommands, and different options +depending on the subcommand: + +[verse] +git reflog expire [--dry-run] [--stale-fix] + [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>... + +git reflog [show] [log-options] Reflog is a mechanism to record when the tip of branches are updated. This command is to manage the information recorded in it. @@ -25,6 +30,10 @@ tip, are removed from the reflog. This is typically not used directly by the end users -- instead, see gitlink:git-gc[1]. +The subcommand "show" (which is also the default, in the absense of any +subcommands) will take all the normal log options, and show the log of +the current branch. It is basically an alias for 'git log -g --abbrev-commit +--pretty=oneline', see gitlink:git-log[1]. OPTIONS
diff --git a/git-show.html b/git-show.html index 257e4b7..48c4c0e 100644 --- a/git-show.html +++ b/git-show.html
@@ -284,6 +284,8 @@ <p>For trees, it shows the names (equivalent to <a href="git-ls-tree.html">git-ls-tree(1)</a> with --name-only).</p> <p>For plain blobs, it shows the plain contents.</p> +<p>The command takes options applicable to the <a href="git-diff-tree.html">git-diff-tree(1)</a> command to +control how the changes the commit introduces are shown.</p> <p>This manual page describes only the most frequently used options.</p> </div> <h2>OPTIONS</h2> @@ -564,7 +566,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 18-Jan-2007 06:24:01 UTC +Last updated 09-Feb-2007 08:38:37 UTC </div> </div> </body>
diff --git a/git-show.txt b/git-show.txt index 9051951..f56f164 100644 --- a/git-show.txt +++ b/git-show.txt
@@ -25,6 +25,9 @@ For plain blobs, it shows the plain contents. +The command takes options applicable to the gitlink:git-diff-tree[1] command to +control how the changes the commit introduces are shown. + This manual page describes only the most frequently used options.
diff --git a/git.html b/git.html index 86bc65b..fa16a8d 100644 --- a/git.html +++ b/git.html
@@ -2296,7 +2296,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 07-Feb-2007 23:17:18 UTC +Last updated 09-Feb-2007 08:38:38 UTC </div> </div> </body>
